-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Gorgias internal notes #17599
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Gorgias internal notes #17599
Conversation
- Add channel selection to create-ticket-message action with internal-note support - Hide from/to fields for internal notes as they don't require recipients - Add dedicated internal-note-created webhook source for better filtering - Update package version to 0.5.2
@seynadio is attempting to deploy a commit to the Pipedreamers Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe changes introduce the ability to handle internal notes for tickets in both Freshdesk and Gorgias integrations. Freshdesk's update-ticket action now supports adding internal notes, while Gorgias gains a new action prop for internal notes, a new event source for detecting internal note creation, and a test event. The Gorgias package version is incremented. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FreshdeskAction
participant FreshdeskAPI
User->>FreshdeskAction: Run update-ticket (with/without internalNote)
alt internalNote is true and noteBody provided
FreshdeskAction->>FreshdeskAPI: POST /tickets/{ticketId}/notes (private note)
FreshdeskAPI-->>FreshdeskAction: Note creation response
FreshdeskAction-->>User: Export summary and response
else
FreshdeskAction->>FreshdeskAPI: PUT /tickets/{ticketId} (update fields)
FreshdeskAPI-->>FreshdeskAction: Ticket update response
FreshdeskAction-->>User: Export summary and response
end
sequenceDiagram
participant User
participant GorgiasAction
participant GorgiasAPI
User->>GorgiasAction: Run create-ticket-message (channel: "email" or "internal-note")
alt channel is "internal-note"
GorgiasAction->>GorgiasAPI: POST /messages (internal note payload)
GorgiasAPI-->>GorgiasAction: Internal note creation response
GorgiasAction-->>User: Export summary (internal note)
else
GorgiasAction->>GorgiasAPI: POST /messages (ticket message payload)
GorgiasAPI-->>GorgiasAction: Ticket message creation response
GorgiasAction-->>User: Export summary (ticket message)
end
sequenceDiagram
participant GorgiasWebhook
participant InternalNoteSource
participant User
GorgiasWebhook-->>InternalNoteSource: Event: TICKET_MESSAGE_CREATED
alt message.channel == "internal-note" and filters match
InternalNoteSource-->>User: Emit internal note event
else
InternalNoteSource--xUser: Ignore event
end
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
components/freshdesk/actions/update-ticket/update-ticket.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/gorgias_oauth/sources/internal-note-created/test-event.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (5)
🧰 Additional context used🧠 Learnings (4)components/gorgias_oauth/package.json (1)
components/gorgias_oauth/sources/internal-note-created/test-event.mjs (3)
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (4)
components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (4)
🔇 Additional comments (11)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified. |
Closing this PR and replacing with #17605 which has only the Gorgias changes (no accidental Freshdesk changes included) |
WHY
- Created dedicated webhook source for internal note events
- Filters specifically for channel === "internal-note"
- Includes test event sample
Summary by CodeRabbit
New Features
Bug Fixes
Chores